Skip to content

Add build infrastructure and update the document with stylistic changes.#59

Merged
klown merged 20 commits intoinclusive-design:mainfrom
jasonjgw:infrastructure
Mar 6, 2026
Merged

Add build infrastructure and update the document with stylistic changes.#59
klown merged 20 commits intoinclusive-design:mainfrom
jasonjgw:infrastructure

Conversation

@jasonjgw
Copy link
Copy Markdown
Contributor

@jasonjgw jasonjgw commented Mar 5, 2026

The individual commits are as follows. The over-all effect is to set up the document build process and to make stylistic changes to the Markdown source. The README file is also updated.

  • feat: create markdown version of the trust meter indroduction google doc
  • Ignore generated files.
  • Add a basic makefile to generate HTML, PDF and Office Open XML/Microsoft Word versions of the document.
  • Add title and author metadata.
  • Use separator (
    ) syntax accepted by Pandoc.
  • Add editorconfig file.
  • Convert the document to Markdown again, this time without line wrapping.
  • Add title again after file format conversion.
  • Enable section numbering for ease of reference. Clarify the makefile.
  • Correct heading levels in the Definitions section.
  • Use correct separator markup in the cover note.
  • Refine makefile by implementing the more useful suggestions in a code review by gemini.google.com (after researching the correctness of the proposed changes).
  • Update README to document the build process.
  • This pull request has been tested by running npm run test without errors
  • This pull request has been built by running npm run build without errors
  • This isn't a duplicate of an existing pull request

Description

Steps to test

Expected behavior:

Additional information

Related issues

klown and others added 13 commits February 25, 2026 17:23
@klown
feat: create markdown version of the trust meter indroduction google doc
37f4aff 
- based on https://docs.google.com/document/d/1ztIIL-xMzFRv_fed1NIc5mY7V5S6hgat2EyoKFSDlG4/edit?tab=t.0 as of 25-Feb-2026
@jasonjgw
Ignore generated files.
30314d7
@jasonjgw
Add a basic makefile to generate HTML, PDF and Office Open XML/Microsoft
38351a7 
Word versions of the document.
@jasonjgw
Add title and author metadata.
6b6d83b
@jasonjgw
Use separator (<HR>) syntax accepted by Pandoc.
67cc939
@jasonjgw
Add editorconfig file.
d675cb2
@jasonjgw
Convert the document to Markdown again, this time without line wrapping.
5023fdf
@jasonjgw
Add title again after file format conversion.
676227f
@jasonjgw
Enable section numbering for ease of reference. Clarify the makefile.
f470037
@jasonjgw
Correct heading levels in the Definitions section.
bc744a2
@jasonjgw
Use correct separator markup in the cover note.
5982d49
@jasonjgw
Refine makefile by implementing the more useful suggestions in a code
71365ff 
review by gemini.google.com (after researching the correctness of the
proposed changes).
@jasonjgw
Update README to document the build process.
46a2dcd
@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Mar 5, 2026 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

klown
klown reviewed Mar 5, 2026
View reviewed changes
Comment thread .gitignore
jobara
jobara reviewed Mar 5, 2026
View reviewed changes
Comment thread .gitignore Outdated
jobara
jobara requested changes Mar 5, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@jobara jobara left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jasonjgw could you remove the spec file from the PR. We are planning to do the edits to that in the "draft" branch and accept comments on the #60 PR and/or issues. When this PR is in, we'll merge main into the draft branch so that you can run the makefile from that branch too.

@jasonjgw
Copy link
Copy Markdown
Contributor Author

jasonjgw commented Mar 5, 2026

I've removed the draft for now as requested.

However, some of the changes were made to the draft itself. They're source formatting and markup changes, not content changes. I assume that I'll submit those in a separate PR once this ie merged.

klown
klown suggested changes Mar 6, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@klown klown left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this, @jasonjgw. Check out my two suggestions and let me know what you think.

Comment thread Makefile Outdated
Comment thread README.md
@jasonjgw
Copy link
Copy Markdown
Contributor Author

jasonjgw commented Mar 6, 2026

In the future, consideration should be given to using Typst rather than TeX to create PDF output. Typst is currently supported by Pandoc for PDF typesetting, but it gives an error (a known bug) with Pandoc 3.5 and Typst 0.14.2 - apparently now fixed in Pandoc but not yet in the released version.

Modern versions of TeX/LaTeX and Typst support tagged PDF (not by default in the case of LaTeX).

For purposes of this PR, I suggest no change be made.

klown
klown approved these changes Mar 6, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@klown klown left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM Thanks again @jasonjgw . I will merge this into main, and then merge main into the draft branch.

@klown klown merged commit f1181b5 into inclusive-design:main Mar 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jobara jobara jobara requested changes

+1 more reviewer

@klown klown klown approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@jasonjgw @CLAassistant @jobara @klown